<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- ../src/examples/analogclock.qdoc -->
<head>
  <title>Analog Clock Example</title>
    <style type="text/css">h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { color: black; }</style>
</head>
<body>
<h1 class="title">Analog Clock Example<br /><span class="subtitle"></span>
</h1>
<p>The Analog Clock example shows how to draw the contents of a custom widget.</p>
<p align="center"><img src="classpath:com/trolltech/images/analogclock-example.png" alt="Screenshot of the Analog Clock example" /></p><p>This example also demonstrates how the transformation and scaling features of QPainter can be used to make drawing custom widgets easier.</p>
<a name="analogclock-class-implementation"></a>
<h2>AnalogClock Class Implementation</h2>
<p>The <tt>AnalogClock</tt> class provides a clock widget with hour and minute hands that is automatically updated every few seconds.</p>
<pre>    public class AnalogClock
        extends QWidget
    {
        static QPolygon hourHand = new QPolygon();
        static QPolygon minuteHand = new QPolygon();
        static {
            hourHand.append(new QPoint(7, 8));
            hourHand.append(new QPoint(-7, 8));
            hourHand.append(new QPoint(0, -40));

            minuteHand.append(new QPoint(7, 8));
            minuteHand.append(new QPoint(-7, 8));
            minuteHand.append(new QPoint(0, -70));
        }

        QTimer m_timer = new QTimer(this);</pre>
<p>We subclass QWidget and define polygons to use for the hour and minute hands, as well as a timer that enables us to update the clock face.</p>
<p>In the constructor, we set up a one-second timer to keep track of the current time, and we connect it to the standard update() slot so that the clock face is updated when the timer emits the timeout() signal:</p>
<pre>        public AnalogClock() {
            this(null);
        }</pre>
<p>We also resize the widget so that it is displayed at a reasonable size.</p>
<p>The <tt>paintEvent()</tt> method is called whenever the widget's contents need to be updated. This happens when the widget is first shown, and when it is covered then exposed, but it is also executed when the widget's update() slot is called. Since we connected the timer's timeout() signal to this slot, it will be called at least once every five seconds.</p>
<pre>        protected void paintEvent(QPaintEvent e)
        {
            QColor hourColor = new QColor(127, 0, 127);
            QColor minuteColor = new QColor(0, 127, 127, 191);

            int side = width() &lt; height() ? width() : height();

            QTime time = QTime.currentTime();</pre>
<p>Before we set up the painter and draw the clock, we first define two QColors that will be used for the hour and minute hands. The minute hand's color has an alpha component of 191, meaning that it's 75% opaque.</p>
<p>We also determine the length of the widget's shortest side so that we can fit the clock face inside the widget. It is also useful to determine the current time before we start drawing.</p>
<pre>            QPainter painter = new QPainter(this);
            painter.setRenderHint(QPainter.RenderHint.Antialiasing);
            painter.translate(width() / 2, height() / 2);
            painter.scale(side / 200.0f, side / 200.0f);</pre>
<p>The contents of custom widgets are drawn with a QPainter. Painters can be used to draw on any QPaintDevice, but they are usually used with widgets, so we pass the widget instance to the painter's constructor.</p>
<p>We call QPainter.setRenderHint() with QPainter.Antialiasing to turn on antialiasing. This makes drawing of diagonal lines much smoother.</p>
<p>The translation moves the origin to the center of the widget, and the scale operation ensures that the following drawing operations are scaled to fit within the widget. We use a scale factor that let's us use x and y coordinates between -100 and 100, and that ensures that these lie within the length of the widget's shortest side.</p>
<p>To make our code simpler, we will draw a fixed size clock face that will be positioned and scaled so that it lies in the center of the widget.</p>
<p>The painter takes care of all the transformations made during the paint event, and ensures that everything is drawn correctly. Letting the painter handle transformations is often easier than performing manual calculations just to draw the contents of a custom widget.</p>
<p align="center"><img src="classpath:com/trolltech/images/analogclock-viewport.png" /></p><p>We draw the hour hand first, using a formula that rotates the coordinate system counterclockwise by a number of degrees determined by the current hour and minute. This means that the hand will be shown rotated clockwise by the required amount.</p>
<pre>            painter.setPen(QPen.NoPen);
            painter.setBrush(hourColor);</pre>
<p>We set the pen to be Qt::NoPen because we don't want any outline, and we use a solid brush with the color appropriate for displaying hours. Brushes are used when filling in polygons and other geometric shapes.</p>
<pre>            painter.save();
            painter.rotate(30.0f * ((time.hour() + time.minute() / 60.0f)));
            painter.drawConvexPolygon(hourHand);
            painter.restore();</pre>
<p>We save and restore the transformation matrix before and after the rotation because we want to place the minute hand without having to take into account any previous rotations.</p>
<pre>            painter.setPen(hourColor);

            for (int i=0; i&lt;12; ++i) {
                painter.drawLine(88, 0, 96, 0);
                painter.rotate(30.0f);
            }</pre>
<p>We draw markers around the edge of the clock for each hour. We draw each marker then rotate the coordinate system so that the painter is ready for the next one.</p>
<pre>            painter.setPen(QPen.NoPen);
            painter.setBrush(minuteColor);

            painter.save();
            painter.rotate(6.0f * (time.minute() + time.second() / 60.0f));
            painter.drawConvexPolygon(minuteHand);
            painter.restore();</pre>
<p>The minute hand is rotated in a similar way to the hour hand.</p>
<pre>            painter.setPen(minuteColor);

            for (int j=0; j&lt;60; ++j) {
                if ((j % 5) != 0)
                    painter.drawLine(92, 0, 96, 0);
                painter.rotate(6.0f);
            }</pre>
<p>Again, we draw markers around the edge of the clock, but this time to indicate minutes. We skip multiples of 5 to avoid drawing minute markers on top of hour markers.</p>
<p>The rest of the class contains a showEvent() implementation that starts the timer when the window is shown, and a hideEvent() implementation that stops it when the window is hidden.</p>
<pre>        public void showEvent(QShowEvent e) {
            m_timer.start(1000);
        }

        @Override
        public void hideEvent(QHideEvent e) {
            m_timer.stop();
        }</pre>
<p>These methods ensure that we don't do unnecessary work when the clock is not visible to the user.</p>
<p>Finally, we provide a <tt>main()</tt> method to create and show the analog clock when the example is run:</p>
<pre>        static public void main(String args[])
        {
            QApplication.initialize(args);
            AnalogClock w = new AnalogClock();

            w.show();

            QApplication.exec();
        }
    }</pre>
</body>
</html>
